<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs for page WikiPlot.php</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="file-name">/WikiPlot.php</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
									<a href="#sec-includes">Includes</a>
			|											<a href="#sec-functions">Functions</a>
			</div>
	<div class="info-box-body">	
		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The MediaWiki extension</p>
<p class="description"><p>This is the MediaWiki extension it self, everything else is just functions and liberaries for this file.</p></p>
	<ul class="tags">
				<li><span class="field">filesource:</span> <a href="../__filesource/fsource_WikiPlot__WikiPlot.php.html">Source Code for this file</a></li>
				<li><span class="field">copyright:</span> Copyright 2006, WikiPlot development team.</li>
				<li><span class="field">author:</span> WikiPlot development team.</li>
				<li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.txt">GNU General Public License</a></li>
			</ul>
		
			</div>
</div>
		

	<a name="sec-includes"></a>	
	<div class="info-box">
		<div class="info-box-title">Includes</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Includes</span>
			|													<a href="#sec-functions">Functions</a>
					</div>
		<div class="info-box-body">	
			<a name="_xml_class_php"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="include-title">
			<span class="include-type">require_once</span>
			(<span class="include-name"><a href="../WikiPlot/_xml.class.php.html">"xml.class.php"</a></span>)
			(line <span class="line-number"><a href="../__filesource/fsource_WikiPlot__WikiPlot.php.html#a36">36</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Include xml.class.php</p>
<p class="description"><p>Requires XMLParser to parse xml to plot.</p></p>
	
</div>
<a name="_cache_class_php"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="include-title">
			<span class="include-type">require_once</span>
			(<span class="include-name"><a href="../WikiPlot/__cache.class.php.html">"cache.class.php"</a></span>)
			(line <span class="line-number"><a href="../__filesource/fsource_WikiPlot__WikiPlot.php.html#a43">43</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Include cache.class.php</p>
<p class="description"><p>Requires Cache to control the cache.</p></p>
	
</div>
<a name="_PlotClass/plot_class_php"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="include-title">
			<span class="include-type">require_once</span>
			(<span class="include-name"><a href="../WikiPlot/PlotClass/__PlotClass---plot.class.php.html">"PlotClass/plot.class.php"</a></span>)
			(line <span class="line-number"><a href="../__filesource/fsource_WikiPlot__WikiPlot.php.html#a29">29</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Include plot.class.php</p>
<p class="description"><p>Requires PlotClass to render plots.</p></p>
	
</div>
		</div>
	</div>
	
	
	
	<a name="sec-functions"></a>	
	<div class="info-box">
		<div class="info-box-title">Functions</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-includes">Includes</a>
				|												<span class="disabled">Functions</span>
		</div>
		<div class="info-box-body">	
			<a name="functionRenderWikiPlot" id="functionRenderWikiPlot"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="method-title">RenderWikiPlot</span> (line <span class="line-number"><a href="../__filesource/fsource_WikiPlot__WikiPlot.php.html#a198">198</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">RenderWikiPlot CallBack function</p>
<p class="description"><p>This is the function that handles MediaWiki callbacks, and renders the actual plot.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> HTML that can be directly inserted into any website.</li>
				<li><span class="field">uses:</span> <a href="../WikiPlot/_WikiPlot.php.html#functionWikiPlotDeserializeInteger">WikiPlotDeserializeInteger()</a></li>
				<li><span class="field">uses:</span> <a href="../WikiPlot/_WikiPlot.php.html#functionWikiPlotDeserializeMixed">WikiPlotDeserializeMixed()</a></li>
				<li><span class="field">uses:</span> <a href="../WikiPlot/_WikiPlot.php.html#functionWikiPlotDeserializeString">WikiPlotDeserializeString()</a></li>
				<li><span class="field">uses:</span> <a href="../WikiPlot/XMLParser.html">XMLParser</a></li>
				<li><span class="field">uses:</span> <a href="../WikiPlot/_WikiPlot.php.html#functionWikiPlotDeserializeColor">WikiPlotDeserializeColor()</a></li>
				<li><span class="field">uses:</span> <a href="../WikiPlot/_WikiPlot.php.html#functionWikiPlotDeserializeBoolean">WikiPlotDeserializeBoolean()</a></li>
				<li><span class="field">uses:</span> <a href="../WikiPlot/Cache.html">Cache</a></li>
				<li><span class="field">uses:</span> <a href="../WikiPlot/PlotClass/Graph.html">Graph</a></li>
				<li><span class="field">uses:</span> <a href="../WikiPlot/PlotClass/Plot.html">Plot</a></li>
				<li><span class="field">access:</span> private</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			RenderWikiPlot
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$input</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$argv</span>, [<span class="var-type">Parser</span>&nbsp;<span class="var-name">$parser</span> = <span class="var-default">null</span>])
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$input</span><span class="var-description">: The content of the wikiplot tag</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$argv</span><span class="var-description">: Hash-array of the parameters of the wikiplot tag, with parameter-name as key and parameter-value as value.</span>			</li>
					<li>
				<span class="var-type">Parser</span>
				<span class="var-name">$parser</span><span class="var-description">: The parser of MediaWiki, if null parser is obtained from global variable</span>			</li>
				</ul>
		
	
</div>
<a name="functionwfWikiPlotExtension" id="functionwfWikiPlotExtension"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="method-title">wfWikiPlotExtension</span> (line <span class="line-number"><a href="../__filesource/fsource_WikiPlot__WikiPlot.php.html#a57">57</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Add hooks</p>
<p class="description"><p>Adds hooks so MediaWiki will perform callback, when it hits the wikiplot tag.</p></p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			wfWikiPlotExtension
		</span>
				()
			</div>

		
	
</div>
<a name="functionWikiPlotDeserializeBoolean" id="functionWikiPlotDeserializeBoolean"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="method-title">WikiPlotDeserializeBoolean</span> (line <span class="line-number"><a href="../__filesource/fsource_WikiPlot__WikiPlot.php.html#a72">72</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Deserialize boolean</p>
<p class="description"><p>Deserializes a boolean value from string, this function is used when you want to deserialize parameters given in the WikiML. If it is impossible to deserialize the value, the output object is not initialized at all.</p></p>
	<ul class="tags">
				<li><span class="field">usedby:</span> <a href="../WikiPlot/_WikiPlot.php.html#functionRenderWikiPlot">RenderWikiPlot()</a></li>
				<li><span class="field">access:</span> private</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			WikiPlotDeserializeBoolean
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>, <span class="var-type">boolean</span>&nbsp;<span class="var-name">&$SetTo</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$value</span><span class="var-description">: The string you wish to deserialize.</span>			</li>
					<li>
				<span class="var-type">boolean</span>
				<span class="var-name">&$SetTo</span><span class="var-description">: The variable you want the values parsed to.</span>			</li>
				</ul>
		
	
</div>
<a name="functionWikiPlotDeserializeColor" id="functionWikiPlotDeserializeColor"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="method-title">WikiPlotDeserializeColor</span> (line <span class="line-number"><a href="../__filesource/fsource_WikiPlot__WikiPlot.php.html#a159">159</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Deserialize Color</p>
<p class="description"><p>Deserializes an array representation of a rgb color from string, this function is used when you want to deserialize parameters given in the WikiML. This function can deserialize colors written as &quot;255,255,255&quot; (rgb) or &quot;#000000&quot; (hex). If it is impossible to deserialize the value, the output object is not initialized at all.</p></p>
	<ul class="tags">
				<li><span class="field">usedby:</span> <a href="../WikiPlot/_WikiPlot.php.html#functionRenderWikiPlot">RenderWikiPlot()</a></li>
				<li><span class="field">access:</span> private</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			WikiPlotDeserializeColor
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">&$SetTo</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$value</span><span class="var-description">: The string you wish to deserialize.</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">&$SetTo</span><span class="var-description">: The variable you want the values parsed to.</span>			</li>
				</ul>
		
	
</div>
<a name="functionWikiPlotDeserializeInteger" id="functionWikiPlotDeserializeInteger"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="method-title">WikiPlotDeserializeInteger</span> (line <span class="line-number"><a href="../__filesource/fsource_WikiPlot__WikiPlot.php.html#a137">137</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Deserialize Integer</p>
<p class="description"><p>Deserializes a integer value from string, this function is used when you want to deserialize parameters given in the WikiML. If it is impossible to deserialize the value, the output object is not initialized at all. Usualy this function does nothing at all, just checks to see if the value can be parsed as an integer.</p></p>
	<ul class="tags">
				<li><span class="field">usedby:</span> <a href="../WikiPlot/_WikiPlot.php.html#functionRenderWikiPlot">RenderWikiPlot()</a></li>
				<li><span class="field">access:</span> private</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			WikiPlotDeserializeInteger
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>, <span class="var-type">Integer</span>&nbsp;<span class="var-name">&$SetTo</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$value</span><span class="var-description">: The string you wish to deserialize.</span>			</li>
					<li>
				<span class="var-type">Integer</span>
				<span class="var-name">&$SetTo</span><span class="var-description">: The variable you want the values parsed to.</span>			</li>
				</ul>
		
	
</div>
<a name="functionWikiPlotDeserializeMixed" id="functionWikiPlotDeserializeMixed"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="method-title">WikiPlotDeserializeMixed</span> (line <span class="line-number"><a href="../__filesource/fsource_WikiPlot__WikiPlot.php.html#a114">114</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Deserialize Coordiante</p>
<p class="description"><p>Deserializes a 2 integers from string, this function is used when you want to deserialize parameters given in the WikiML. If it is impossible to deserialize the value, the output object is not initialized at all.</p></p>
	<ul class="tags">
				<li><span class="field">usedby:</span> <a href="../WikiPlot/_WikiPlot.php.html#functionRenderWikiPlot">RenderWikiPlot()</a></li>
				<li><span class="field">access:</span> private</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			WikiPlotDeserializeMixed
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">&$SetTo1</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">&$SetTo2</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$value</span><span class="var-description">: The string you wish to deserialize.</span>			</li>
					<li>
				<span class="var-type">integer</span>
				<span class="var-name">&$SetTo1</span><span class="var-description">: The variable you want the values parsed to.</span>			</li>
					<li>
				<span class="var-type">integer</span>
				<span class="var-name">&$SetTo2</span><span class="var-description">: The variable you want the values parsed to.</span>			</li>
				</ul>
		
	
</div>
<a name="functionWikiPlotDeserializeString" id="functionWikiPlotDeserializeString"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="method-title">WikiPlotDeserializeString</span> (line <span class="line-number"><a href="../__filesource/fsource_WikiPlot__WikiPlot.php.html#a94">94</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Deserialize String</p>
<p class="description"><p>Deserializes a string value from string, this function is used when you want to deserialize parameters given in the WikiML. If it is impossible to deserialize the value, the output object is not initialized at all. Usualy this function does nothing.</p></p>
	<ul class="tags">
				<li><span class="field">usedby:</span> <a href="../WikiPlot/_WikiPlot.php.html#functionRenderWikiPlot">RenderWikiPlot()</a></li>
				<li><span class="field">access:</span> private</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			WikiPlotDeserializeString
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">&$SetTo</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$value</span><span class="var-description">: The string you wish to deserialize.</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">&$SetTo</span><span class="var-description">: The variable you want the values parsed to.</span>			</li>
				</ul>
		
	
</div>
		</div>
	</div>
	
	<p class="notes" id="credit">
		Documentation generated on Fri, 13 Oct 2006 16:12:27 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0</a>
	</p>
	</div></body>
</html>